ARDK for Android/com.nianticlabs.ardk/VPSConfig

VPSConfig

class VPSConfig(var enableContinuousLocalization: Boolean = false, val cloudInitialRequestsPerSecond: Float = 1.0f, val cloudContinuousRequestsPerSecond: Float = 0.2f, val enableTemporalFusion: Boolean = false, val enableInterpolation: Boolean = false, val jpegCompressionQuality: Int = 50, val enableDeviceMapLocalization: Boolean = false, val enableVPSDebugger: Boolean = false, val enableGpsCorrectionForContinuousLocalization: Boolean = true)

Configuration structure for the VPS session.

VPSConfig allows you to customize VPS behavior including localization frequency, quality settings, and advanced features like temporal fusion. Use this class to optimize VPS performance for your specific use case.

Usage

val config = VPSConfig(
    enableContinuousLocalization = true,
    cloudInitialRequestsPerSecond = 2.0f,
    jpegCompressionQuality = 80
)
vpsSession.configure(config)

See also

VPSSession.configure

Constructors

VPSConfig

[androidJvm] constructor(enableContinuousLocalization: Boolean = false, cloudInitialRequestsPerSecond: Float = 1.0f, cloudContinuousRequestsPerSecond: Float = 0.2f, enableTemporalFusion: Boolean = false, enableInterpolation: Boolean = false, jpegCompressionQuality: Int = 50, enableDeviceMapLocalization: Boolean = false, enableVPSDebugger: Boolean = false, enableGpsCorrectionForContinuousLocalization: Boolean = true)

Properties

Name	Summary
cloudContinuousRequestsPerSecond	[androidJvm] val cloudContinuousRequestsPerSecond: Float = 0.2f Defines the number of localization requests per second which are sent to the VPS server after the first successful localization. This is only used if continuous localization is enabled.
cloudInitialRequestsPerSecond	[androidJvm] val cloudInitialRequestsPerSecond: Float = 1.0f Defines the number of localization requests per second which are sent to the VPS server prior to the first successful localization.
enableContinuousLocalization	[androidJvm] var enableContinuousLocalization: Boolean Whether to enable continuous localization.
enableDeviceMapLocalization	[androidJvm] val enableDeviceMapLocalization: Boolean = false Enables localization against device-created maps.
enableGpsCorrectionForContinuousLocalization	[androidJvm] val enableGpsCorrectionForContinuousLocalization: Boolean = true Whether to enable GPS correction for continuous localization.
enableInterpolation	[androidJvm] val enableInterpolation: Boolean = false Whether to enable interpolation.
enableTemporalFusion	[androidJvm] val enableTemporalFusion: Boolean = false Whether to enable temporal fusion.
enableVPSDebugger	[androidJvm] val enableVPSDebugger: Boolean = false Enable VPS Debugger.
jpegCompressionQuality	[androidJvm] val jpegCompressionQuality: Int = 50 Defines the quality of the JPEG compression used for the camera image sent to the VPS server as part of a localization request. Lower values will result in lower bandwidth usage.